<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" /><title>BasicTranslator xref</title>
<link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../../../../../../../../../../apidocs/org/sakaiproject/genericdao/springjdbc/translators/BasicTranslator.html">View Javadoc</a></div><pre>

<a name="1" href="#1">1</a>   <em>/**<em>*</em></em>
<a name="2" href="#2">2</a>   <em> * $Id: BasicTranslator.html 11 2009-01-29 14:58:33Z azeckoski $</em>
<a name="3" href="#3">3</a>   <em> * $URL: http://genericdao.googlecode.com/svn/maven/site/xref/org/sakaiproject/genericdao/springjdbc/translators/BasicTranslator.html $</em>
<a name="4" href="#4">4</a>   <em> * BasicTranslator.java - genericdao - Apr 26, 2008 1:52:06 PM - azeckoski</em>
<a name="5" href="#5">5</a>   <em> **************************************************************************</em>
<a name="6" href="#6">6</a>   <em> * Copyright (c) 2008 Aaron Zeckoski</em>
<a name="7" href="#7">7</a>   <em> * Licensed under the Apache License, Version 2</em>
<a name="8" href="#8">8</a>   <em> * </em>
<a name="9" href="#9">9</a>   <em> * A copy of the Apache License, Version 2 has been included in this </em>
<a name="10" href="#10">10</a>  <em> * distribution and is available at: <a href="http://www.apache.org/licenses/LICENSE-2.0.txt" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0.txt</a></em>
<a name="11" href="#11">11</a>  <em> *</em>
<a name="12" href="#12">12</a>  <em> * Aaron Zeckoski (azeckoski@gmail.com) (aaronz@vt.edu) (aaron@caret.cam.ac.uk)</em>
<a name="13" href="#13">13</a>  <em> */</em>
<a name="14" href="#14">14</a>  
<a name="15" href="#15">15</a>  <strong>package</strong> org.sakaiproject.genericdao.springjdbc.translators;
<a name="16" href="#16">16</a>  
<a name="17" href="#17">17</a>  <strong>import</strong> java.lang.annotation.Annotation;
<a name="18" href="#18">18</a>  
<a name="19" href="#19">19</a>  <strong>import</strong> org.azeckoski.reflectutils.ClassFields;
<a name="20" href="#20">20</a>  <strong>import</strong> org.azeckoski.reflectutils.ReflectUtils;
<a name="21" href="#21">21</a>  <strong>import</strong> org.sakaiproject.genericdao.api.annotations.PersistentTableName;
<a name="22" href="#22">22</a>  <strong>import</strong> org.sakaiproject.genericdao.api.translators.DatabaseTranslator;
<a name="23" href="#23">23</a>  
<a name="24" href="#24">24</a>  
<a name="25" href="#25">25</a>  <em>/**<em>*</em></em>
<a name="26" href="#26">26</a>  <em> * A basic translator class to extend</em>
<a name="27" href="#27">27</a>  <em> * </em>
<a name="28" href="#28">28</a>  <em> * @author Aaron Zeckoski (azeckoski@gmail.com)</em>
<a name="29" href="#29">29</a>  <em> */</em>
<a name="30" href="#30">30</a>  <strong>public</strong> <strong>abstract</strong> <strong>class</strong> <a href="../../../../../org/sakaiproject/genericdao/springjdbc/translators/BasicTranslator.html">BasicTranslator</a> implements <a href="../../../../../org/sakaiproject/genericdao/api/translators/DatabaseTranslator.html">DatabaseTranslator</a> {
<a name="31" href="#31">31</a>  
<a name="32" href="#32">32</a>      <em>/**<em>*</em></em>
<a name="33" href="#33">33</a>  <em>     * Create a tablename from a given class</em>
<a name="34" href="#34">34</a>  <em>     */</em>
<a name="35" href="#35">35</a>      <strong>public</strong> <strong>static</strong> String makeTableNameFromClass(Class&lt;?> pClass) {
<a name="36" href="#36">36</a>          String tableName = <strong>null</strong>;
<a name="37" href="#37">37</a>          <em class="comment">// try to get from class annotations first</em>
<a name="38" href="#38">38</a>          ClassFields&lt;?> classFields = ReflectUtils.getInstance().analyzeClass(pClass);
<a name="39" href="#39">39</a>          <strong>if</strong> (<strong>class</strong>Fields.getClassAnnotations().contains(PersistentTableName.<strong>class</strong>)) {
<a name="40" href="#40">40</a>              <strong>for</strong> (Annotation classAnnote : classFields.getClassAnnotations()) {
<a name="41" href="#41">41</a>                  <strong>if</strong> (PersistentTableName.<strong>class</strong>.equals(<strong>class</strong>Annote.annotationType())) {
<a name="42" href="#42">42</a>                      tableName = ((PersistentTableName)classAnnote).value();
<a name="43" href="#43">43</a>                      <strong>break</strong>;
<a name="44" href="#44">44</a>                  }
<a name="45" href="#45">45</a>              }
<a name="46" href="#46">46</a>          }
<a name="47" href="#47">47</a>          <strong>if</strong> (tableName == <strong>null</strong>) {
<a name="48" href="#48">48</a>              String name = pClass.getSimpleName();
<a name="49" href="#49">49</a>              tableName = makeDBNameFromCamelCase(name);
<a name="50" href="#50">50</a>              <strong>if</strong> (tableName.startsWith(<span class="string">"_"</span>) &amp;&amp; tableName.length() > 1) {
<a name="51" href="#51">51</a>                  tableName = tableName.substring(1);
<a name="52" href="#52">52</a>              }
<a name="53" href="#53">53</a>          }
<a name="54" href="#54">54</a>          <strong>return</strong> tableName;
<a name="55" href="#55">55</a>      }
<a name="56" href="#56">56</a>  
<a name="57" href="#57">57</a>      <em>/**<em>*</em></em>
<a name="58" href="#58">58</a>  <em>     * Create a string that can be used for a DB name that is compatible with most databases (30 chars or less)</em>
<a name="59" href="#59">59</a>  <em>     * @param camelCase a string in camelCase (e.g. someString, MyString)</em>
<a name="60" href="#60">60</a>  <em>     * @return a string in DB style (e.g SOME_STRING, _MY_STRING)</em>
<a name="61" href="#61">61</a>  <em>     */</em>
<a name="62" href="#62">62</a>      <strong>public</strong> <strong>static</strong> String makeDBNameFromCamelCase(String camelCase) {
<a name="63" href="#63">63</a>          String dbCase;
<a name="64" href="#64">64</a>          <strong>if</strong> (camelCase.equals(camelCase.toUpperCase())) {
<a name="65" href="#65">65</a>              <em class="comment">// name is already uppercase</em>
<a name="66" href="#66">66</a>              dbCase = camelCase;
<a name="67" href="#67">67</a>          } <strong>else</strong> {
<a name="68" href="#68">68</a>              StringBuilder sb = <strong>new</strong> StringBuilder();
<a name="69" href="#69">69</a>              <strong>for</strong> (<strong>int</strong> i = 0; i &lt; camelCase.length(); i++) {
<a name="70" href="#70">70</a>                  <strong>char</strong> c = camelCase.<strong>char</strong>At(i);
<a name="71" href="#71">71</a>                  <strong>if</strong> (Character.isUpperCase(c)) {
<a name="72" href="#72">72</a>                      sb.append(<span class="string">"_"</span>);
<a name="73" href="#73">73</a>                  }
<a name="74" href="#74">74</a>                  sb.append(c);
<a name="75" href="#75">75</a>              }
<a name="76" href="#76">76</a>              dbCase = sb.toString().toUpperCase();
<a name="77" href="#77">77</a>          }
<a name="78" href="#78">78</a>          <strong>return</strong> chopString(dbCase, 30);
<a name="79" href="#79">79</a>      }
<a name="80" href="#80">80</a>  
<a name="81" href="#81">81</a>      <em>/**<em>*</em></em>
<a name="82" href="#82">82</a>  <em>     * @param dbName a string in DB style (e.g SOME_STRING, MY_STRING, _MY_STRING)</em>
<a name="83" href="#83">83</a>  <em>     * @return a string in camelCase (e.g. someString, myString, MyString)</em>
<a name="84" href="#84">84</a>  <em>     */</em>
<a name="85" href="#85">85</a>      <strong>public</strong> <strong>static</strong> String makeCamelCaseFromDBName(String dbName) {
<a name="86" href="#86">86</a>          String camelCase;
<a name="87" href="#87">87</a>          <strong>if</strong> (! dbName.equals(dbName.toUpperCase()) 
<a name="88" href="#88">88</a>                  &amp;&amp; dbName.indexOf('_') == -1) {
<a name="89" href="#89">89</a>              <em class="comment">// name is probably already fine</em>
<a name="90" href="#90">90</a>              camelCase = dbName;
<a name="91" href="#91">91</a>          } <strong>else</strong> {
<a name="92" href="#92">92</a>              StringBuilder sb = <strong>new</strong> StringBuilder();
<a name="93" href="#93">93</a>              dbName = dbName.toLowerCase();
<a name="94" href="#94">94</a>              <strong>for</strong> (<strong>int</strong> i = 0; i &lt; dbName.length(); i++) {
<a name="95" href="#95">95</a>                  <strong>char</strong> c = dbName.<strong>char</strong>At(i);
<a name="96" href="#96">96</a>                  <strong>if</strong> (c == '_') {
<a name="97" href="#97">97</a>                      i++;
<a name="98" href="#98">98</a>                      <strong>try</strong> {
<a name="99" href="#99">99</a>                          c = Character.toUpperCase(dbName.charAt(i));
<a name="100" href="#100">100</a>                     } <strong>catch</strong> (IndexOutOfBoundsException e) {
<a name="101" href="#101">101</a>                         <em class="comment">// end of string</em>
<a name="102" href="#102">102</a>                         <strong>break</strong>;
<a name="103" href="#103">103</a>                     }
<a name="104" href="#104">104</a>                 }
<a name="105" href="#105">105</a>                 sb.append(c);
<a name="106" href="#106">106</a>             }
<a name="107" href="#107">107</a>             camelCase = sb.toString();
<a name="108" href="#108">108</a>         }
<a name="109" href="#109">109</a>         <strong>return</strong> camelCase;
<a name="110" href="#110">110</a>     }
<a name="111" href="#111">111</a> 
<a name="112" href="#112">112</a>     <em>/**<em>*</em></em>
<a name="113" href="#113">113</a> <em>     * Chop a string to the mexLength if it is longer and return the chopped string</em>
<a name="114" href="#114">114</a> <em>     * @param str</em>
<a name="115" href="#115">115</a> <em>     * @param maxLength</em>
<a name="116" href="#116">116</a> <em>     * @return the chopped string</em>
<a name="117" href="#117">117</a> <em>     */</em>
<a name="118" href="#118">118</a>     <strong>public</strong> <strong>static</strong> String chopString(String str, <strong>int</strong> maxLength) {
<a name="119" href="#119">119</a>         <strong>if</strong> (str == <strong>null</strong> || <span class="string">""</span>.equals(str)) { <strong>return</strong> <span class="string">""</span>; }
<a name="120" href="#120">120</a>         <strong>if</strong> (str.length() > maxLength) {
<a name="121" href="#121">121</a>             str = str.substring(0, 29);
<a name="122" href="#122">122</a>         }
<a name="123" href="#123">123</a>         <strong>return</strong> str;
<a name="124" href="#124">124</a>     }
<a name="125" href="#125">125</a> 
<a name="126" href="#126">126</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>

